API Documentation
Public Member Functions | List of all members
nkGraphics::GraphicSystem Class Referencefinal

The graphic system used. More...

Public Member Functions

 GraphicSystem ()
 
 ~GraphicSystem ()
 
RenderergetRenderSystem () const
 
bool initialize (ConfigHolder &config)
 
bool frame ()
 
void shutdown ()
 
void noticeRenderWindowChanged (nkWinUi::GraphicsWindow *win)
 

Detailed Description

The graphic system used.

This API is a remnant of early component's days and might be moved to the main system.

Constructor & Destructor Documentation

◆ GraphicSystem()

nkGraphics::GraphicSystem::GraphicSystem ( )

Constructor. In theory, should not be called by external code. The system is made available through the MainSystem.

◆ ~GraphicSystem()

nkGraphics::GraphicSystem::~GraphicSystem ( )

Destructor.

Member Function Documentation

◆ getRenderSystem()

Renderer* nkGraphics::GraphicSystem::getRenderSystem ( ) const
Returns
The render system currently used.

◆ initialize()

bool nkGraphics::GraphicSystem::initialize ( ConfigHolder config)

Initializes the system, preparing it for framing.

Parameters
configThe configuration to initialize from.
Returns
If the initialization process went well (true) or not (false).

◆ frame()

bool nkGraphics::GraphicSystem::frame ( )

Frames once.

Returns
If the rendering of the frame went well (true) or not (false).

◆ shutdown()

void nkGraphics::GraphicSystem::shutdown ( )

Shuts down the system, and free all its memory. Part of the MainSystem shutdown routine.

◆ noticeRenderWindowChanged()

void nkGraphics::GraphicSystem::noticeRenderWindowChanged ( nkWinUi::GraphicsWindow *  win)

Used to notify when a window used for rendering changed. This triggers all the logic for resizing internal buffers, and so on.


The documentation for this class was generated from the following file: